controlKeyDown

Type

message

Summary

Sent when a Control key combination is pressed.

Syntax

controlKeyDown <pKeyName>

Description

Handle the controlKeyDown message if you want to provide Control-key shortcuts on Mac OS systems.

The message is sent to the active (focused) control, or to the current card if no control is focused.

If the Control key is pressed along with the Return key, Tab key, or Enter key, or with an arrow key, no controlKeyDown message is sent. Instead, the returnKey, tabKey, enterKey, or arrowKey message is sent. To trap a combination such as Control-Return, use a returnKey handler and check the controlKey function inside the handler.

Cross-platform note

On Mac OS systems, the controlKeyDown message is sent when a control key combination is pressed. On Windows systems, a control key combination sends a commandKeyDown message instead, and the controlKeyDown message is never sent. On Unix systems, the controlKeyDown message is sent only if Mod2 has been defined.

Parameters

Name	Type	Description
pKeyName		The actual character of the pressed key.

Examples

on controlKeyDown pKey -- make Control-D delete the current card
  if pKey is "D" then 
    delete this card
  else 
    pass controlKeyDown
  end if
end controlKeyDown

Related

control structure: function

function: controlKey, keysDown

glossary: handler, Windows, key combination, message, Mac OS, Unix

message: enterKey, optionKeyDown, tabKey, commandKeyDown, keyDown, arrowKey, returnKey

Compatibility and Support

Introduced

LiveCode 1.0

OS

mac

linux

Platforms

desktop

server